home *** CD-ROM | disk | FTP | other *** search
/ Aminet 52 / Aminet 52 (2002)(GTI - Schatztruhe)[!][Dec 2002].iso / Aminet / text / misc / rman.lha / rman-3.0.9 / ANNOUNCE-rman next >
Text File  |  2000-06-22  |  5KB  |  102 lines
  1. SOFTWARE: RosettaMan, a manual page to HTML converter
  2.  
  3. A new version of PolyglotMan, a generalized filter for UNIX manual
  4. pages, is now available for anonymous ftp from
  5. <URL:ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/rman.tar.Z>.
  6. (It was formerly known as RosettaMan; the name was changed due
  7. to a lawsuit by Rosetta, Inc.)
  8. If you're running X Windows on a UNIX box, you may also wish to check
  9. out TkMan, a graphical, hypertext manual page browser that takes
  10. advantage of PolyglotMan's advanced manual page analysis, from
  11. <URL:ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/tkman.tar.Z>.
  12.  
  13. The biggest change is that now, in addition to preformatted pages,
  14. PolyglotMan can operate on [tn]roff source.  When it recognized the
  15. macros, the results can be superior.  At the moment, this has been
  16. most thoroughly tested for HTML.  terrific on pages that used standard
  17. set of man pages macros, like tcsh.1, and extensions for Tcl/Tk man pages,
  18. and can substitute macros, but million macros usually bad sign.  
  19. if so, format with nroff and feed that output to PolyglotMan.  Tables!
  20.  
  21. tested with man pages from Solaris, HP/UX, DEC OSF/1
  22. on output formats HTML
  23.  
  24. ======================================================================
  25.  
  26. PolyglotMan (nee RosettaMan) is a filter for UNIX manual pages.  It
  27. takes as input man pages for a variety of UNIX flavors and produces as
  28. output a variety of file formats.  Currently PolyglotMan accepts man
  29. pages from the following flavors of UNIX: Hewlett-Packard HP-UX, AT&T
  30. System V, SunOS, Sun Solaris, OSF/1, DEC Ultrix, SGI IRIX, Linux, SCO,
  31. FreeBSD; and produces output for the following formats: printable
  32. ASCII only (stripping page headers and footers), section and
  33. subsection headers only, TkMan, [tn]roff, RTF, SGML (soon--I finally
  34. found a DTD), HTML, MIME, LaTeX, LaTeX 2e, Perl 5's pod.  Previously
  35. <I>PolyglotMan</I> required pages to be formatted by nroff prior to
  36. its processing; with version 3.0, it prefers [tn]roff source and
  37. usually can produce results that are better yet.
  38.  
  39. PolyglotMan improves upon other man page filters in several ways: (1) its
  40. analysis recognizes the structural pieces of man pages, enabling high
  41. quality output, (2) its modular structure permits easy augmentation of
  42. output formats, (3) it accepts man pages formatted with the variant
  43. macros of many different flavors of UNIX, and (4) it doesn't require
  44. modification of or cooperation with any other program.
  45.  
  46. PolyglotMan is a rewrite of TkMan's man page filter, called bs2tk.  (If
  47. you haven't heard about TkMan, a hypertext man page browser, you
  48. should grab it via anonymous ftp from ftp.cs.berkeley.edu:
  49. /ucb/people/phelps/tkman.tar.Z.)  Whereas bs2tk generated output only for
  50. TkMan, PolyglotMan generalizes the process so that the analysis can be
  51. leveraged to new output formats.  A single analysis engine recognizes
  52. section heads, subsection heads, body text, lists, references to other
  53. man pages, boldface, italics, bold italics, special characters (like
  54. bullets), tables (to a degree) and strips out page headers and
  55. footers.  The engine sends signals to the selected output functions so
  56. that an enhancement in the engine improves the quality of output of
  57. all of them.  Output format functions are easy to add, and thus far
  58. average about about 75 lines of C code each.
  59.  
  60. A note for HTML consumers:  This filter does real (heuristic) parsing--
  61. no <PRE>!  Man page references are turned into hypertext links.  The files 
  62. <URL:ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/sgi-ls.1.html>
  63. and <URL:ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/ksh.1.html>
  64. are examples of the quality of output produced entirely automatically
  65. (no retouching) by PolyglotMan.  These translations were produced by
  66. PolyglotMan starting with the [tn]roff source (again no retouching).
  67. Several people have extended World Wide Web servers to format man pages 
  68. on the fly.  Check the README file in the contrib directory for a list.
  69.  
  70.  
  71. CHANGES in 3.0
  72.  
  73. * [tn]roff source preferred for superior results, when roff macros are
  74.   sufficiently recognized.  Autodetection of source or formatted input.
  75. * New software license that makes it free for any use
  76.  
  77.  
  78. CHANGES in 2.5
  79.  
  80. * SGML output format that adheres to Davenport DocBook v2.3 DTD
  81.   (NOT READY IN CURRENT VERSION!)
  82. * MIME output format, for e-mail and Emacs 19.29's enriched mode
  83.   (Neal Becker)
  84. * port to Macintosh by Matthias Neeracher
  85. * list of valid volume names can be given as a parameter (Dag Nygren)
  86. * updated to LaTeX2e (H. Palme)
  87. * debugging scaffolding erected (at the end of software's development cycle!)
  88.  
  89.  
  90. CHANGES in 2.2
  91.  
  92. * when in SEE ALSO, hyphens would confuse man page-reference finder, 
  93.   so re-linebreak if necessary to eliminate them (!) (Greg Earle & Uri Guttman)
  94.  
  95.  
  96. CHANGES in 2.1
  97.  
  98. * gets() replaced by custom code.  gets() deprecated since it reads until \0, 
  99.   introducing security problems. (Robert Withrow)
  100.  
  101. * TkMan module revised for Tk 4.0
  102.